home *** CD-ROM | disk | FTP | other *** search
/ Software of the Month Club 1996 April / Software of the Month Club 1996 April.iso / mac / SRI / General Interest / Heritage / Heritage Documentation < prev    next >
Encoding:
Text File  |  1994-04-12  |  9.0 KB  |  242 lines  |  [TEXT/ttxt]
  1. Introduction
  2. ===========
  3.  
  4. Welcome to Heritage Genealogy, a shareware program to track family 
  5. histories.  I developed this software to track my own family history, and 
  6. I built some features that I wanted to have:
  7.  
  8. (1) No limit on the number of people who can be put in the database, and 
  9. no limits on number of marriages or children per individual.
  10.  
  11. (2) An ability to incorporate arbitrary textual and biographical 
  12. information for each individual.
  13.  
  14. (3) An ability to display digitized photographs of individuals.
  15.  
  16. (4) An ability to determine the exact relationship any two individuals have.
  17.  
  18. If this program does not have a feature that you would like, please send 
  19. me a note.  I promise to take all suggestions for enhancement and improvement
  20. seriously.
  21.  
  22. I have included a sample genealogy for the Tudor Kings and Queens of 
  23. England.  All of the features of this program can be demonstrated using 
  24. this example.
  25.  
  26. If you like this program please register it by sending a check for 
  27. $12 to
  28.  
  29. TAG Software
  30. 14049 232nd Avenue, S.E.
  31. Issaquah, WA 98027
  32.  
  33. Unregistered copies are limited to 40 people.  Registering your copy 
  34. eliminates this limit and entitles you to
  35.  
  36. (1) A full-featured, fully operational, genealogy program.
  37.  
  38. (2) Notification by e-mail when new versions are available (Internet 
  39. only).  The $12 shareware fee is a one time charge, so there is no 
  40. incentive to wait for subsequent, enhanced versions before registering.
  41.  
  42. (3) My gratitude.
  43.  
  44. Preliminaries
  45. ============
  46.  
  47. This program requires System 7 and makes some assumptions about the 
  48. location of some files.  Inside the folder in which the Heritage 
  49. application is stored, the program expects to find two files and two 
  50. folders.  The files are "People" and "Families," and the folders are 
  51. "Biographies" and "Photographs."  The two files can be created using any 
  52. application which creates text files.  The "Biographies" folder, too, 
  53. contains files which are arbitrary text files.  The "Photographs" folder 
  54. contains files which can be created by any application which creates PICT 
  55. files.
  56.  
  57. Running Heritage
  58. ===============
  59.  
  60. When the application is launched, it creates a window which contains a 
  61. scrollable list of the names of all the people in the database.  This 
  62. list of names can be alphabetized by selecting "Reorder File" from the 
  63. file menu at any time.  The program assumes that surnames are entered 
  64. into the database in all capital letters and makes its alphabetizing 
  65. decisions accordingly.
  66.  
  67. Selecting a name from the list makes that name the primary key and 
  68. enables options on the "Information" menu.  These options do what one 
  69. might expect:
  70.  
  71. --Ancestors
  72.  
  73. Display all of the ancestors of the primary key.  Each individual's 
  74. father's name is listed on the line below his own.  His mother's name is 
  75. connected by a vertical line to his father's.  Thus
  76.  
  77. AAAA
  78.   BBBB
  79.   |  CCCC
  80.   |  DDDD
  81.   EEEE
  82.  
  83. AAAA's father is BBBB, and his mother is EEEE.  BBBB's father is CCCC, 
  84. and BBBB's mother is DDDD.
  85.  
  86. --Descendants
  87.  
  88. Display all of the descendants of the primary key.  Each individual's 
  89. children's names are listed on the line below his own.  His children are 
  90. all connected by vertical lines.  Thus
  91.  
  92. AAAA
  93.   BBBB
  94.   |  CCCC
  95.   |  DDDD
  96.   EEEE
  97.   |  FFFF
  98.   GGGG
  99.  
  100. AAAA's children are BBBB, EEEE, and GGGG.  BBBB's children are CCCC and 
  101. DDDD, while EEEE's child is FFFF.
  102.  
  103. --Biography
  104.  
  105. Display a biography of the primary key.
  106.  
  107. --Photograph
  108.  
  109. Show a photograph of the primary key.
  110.  
  111. --Relationship
  112.  
  113. Display the exact relationship of the primary key to the secondary key.  
  114. (The secondary key is created by choosing "Make Secondary" from the 
  115. "Navigate" menu.  This menu option makes the primary key the secondary 
  116. key.)  The "Relationship" option finds a common ancestor of the primary 
  117. and secondary keys and displays only those descendants of the common 
  118. ancestor who are themselves ancestors of the primary or secondary keys.
  119.  
  120. When any of these items are selected, the "Copy" option in the "File" 
  121. menu is enabled.  Selecting copy puts all of the information in the 
  122. popup window into the clipboard, where it can be pasted into arbitrary
  123. documents using almost any application.
  124.  
  125. Data Entry
  126. =========
  127.  
  128. This is, admittedly, the weakest aspect of the program.  Adding some data 
  129. entry screens is the highest priority item for version 2 of the 
  130. software.  In the meantime, however, it is possible to accomplish data 
  131. entry using any text editor or word processor.  The two files which must 
  132. be manipulated are the "People" file and the "Families" file mentioned 
  133. earlier.  Use your favorite text editor to look at these two files for 
  134. the Tudor kings and queens example.
  135.  
  136. Consider the "People" file first.  The first line of this file contains the 
  137. number of people in the database.  Subsequent lines in this file contain 
  138. the individual records for each of the people.  A record consists of the 
  139. index number of the individual, the name of the individual, optional 
  140. information fields, and a terminating semicolon.  Line breaks and spaces 
  141. are ignored, so the terminating semicolon is essential for proper reading 
  142. of the file.
  143.  
  144. The index numbers start with zero and increase by one for each subsequent 
  145. record.  They must be assigned in order with no gaps.  They are only in 
  146. the file to make the creation and editing of the "Families" file easier.
  147.  
  148. A name may be any text string terminated by a semicolon.  The program 
  149. assumes that surnames are all capitalized.  The "Reorder File" command 
  150. will not work properly if this assumption is violated.
  151.  
  152. The optional fields are given by a one letter code followed by the 
  153. information.  These can be any of (in any order)
  154.  
  155. b mm/dd/yyyy - Date of birth.  Zeros can be used if exact months or days 
  156. are not known.  Thus, 0/0/1743 refers to sometime during 1743, while 
  157. 11/0/1826 means sometime in November, 1826.  The full four digits of the 
  158. year must be specified.
  159.  
  160. B location; - Place of birth.  The location is any text string terminated 
  161. by a semicolon.
  162.  
  163. d mm/dd/yyyy - Date of death.
  164.  
  165. D location; - Place of death.  The location must be terminated by a 
  166. semicolon.
  167.  
  168. l file; - Biography file.  "file" is the name of a text file in the 
  169. "Biographies" folder which contains additional biographical information 
  170. for this person.  It will be displayed whenever a biography is 
  171. requested.  "file" must be terminated with a semicolon.
  172.  
  173. p file; - Photograph file.  "file" is the name of a PICT file in the 
  174. "Photographs" folder which contains a photograph of this person.  It will 
  175. be displayed whenever "Photograph" is selected from the "Information" menu.
  176.  
  177. s n m1 m2 ... mn - Spousal information.  n is the number of marriages 
  178. this person has had, while m1, m2, ... , mn refer to the indices of the 
  179. marriage records in the "Families" file for each of the n marriages.
  180.  
  181. Each of these records must be terminated by a semicolon, even if 
  182. the previous information field ended in a semicolon.  See the "People" 
  183. file for the Tudor kings and queens for more information.
  184.  
  185. Now consider the "Families" file.  The first line of this file contains the 
  186. number of marriages in the database.  Subsequent lines in this file contain 
  187. the individual records for each of the marriages.  A record consists of the 
  188. index number of the marriage, optional information fields, and a 
  189. terminating semicolon.  Line breaks and spaces are ignored, so the 
  190. terminating semicolon is essential for proper reading of the file.
  191.  
  192. The index numbers start with zero and increase by one for each subsequent 
  193. record.  They must be assigned in order with no gaps.
  194.  
  195. The optional fields are given by a one letter code followed by the 
  196. information.  These can be any of (in any order)
  197.  
  198. h n - Husband.  The husband in this marriage is number n from the 
  199. "People" file.
  200.  
  201. w n - Wife.  The wife in this marriage is number n from the "People file.
  202.  
  203. m mm/dd/yyyy - Date of marriage.
  204.  
  205. M location; - Place of marriage.  location must be terminated by a 
  206. semicolon.
  207.  
  208. d mm/dd/yyyy - Date of divorce.
  209.  
  210. c n c1 c2 ... cn - Children.  This marriage has produced n children who 
  211. are numbers c1, c2, ..., cn in the "People" file.
  212.  
  213. See the "Families" file for the Tudor kings and queens for an example.
  214.  
  215. I readily admit that this is too complicated and too error prone.  I hope 
  216. to have data entry screens in place within a few months, assuming I get a 
  217. chance to work on this.  At that point, a lot of this nonsense can go away.
  218. Ultimately, the goal is the make the only access to the "People" and 
  219. "Families" files through the Heritage application.
  220.  
  221. Bug Reports, Comments, etc.
  222. =========================
  223.  
  224. I am interested in receiving feedback of all kinds about this software.  
  225. I am so interested in feedback, in fact, that I make the following offer:
  226.  
  227. (1) I will pay $1 to any registered user who reports a bug that I am 
  228. unaware of in the software.
  229.  
  230. (2) I will pay $2 to any registered user for any improvement or new feature 
  231. suggestion that is not already on my "To Do" list that I decide to add when 
  232. it becomes part of the software.
  233.  
  234. Although I won't actually pay for complaints, I welcome them 
  235. nevertheless.  Feedback of any kind can be sent to
  236.  
  237. TAG Software
  238. 14049 232nd Avenue, S.E.
  239. Issaquah, WA 98027
  240.  
  241.  
  242.